org.springframework.http.client.reactive

Class AbstractClientHttpRequest

java.lang.Object

org.springframework.http.client.reactive.AbstractClientHttpRequest

All Implemented Interfaces:

ClientHttpRequest, HttpMessage, ReactiveHttpOutputMessage

Direct Known Subclasses:

MockClientHttpRequest, ReactorClientHttpRequest

public abstract class AbstractClientHttpRequest
extends java.lang.Object
implements ClientHttpRequest

Base class for ClientHttpRequest implementations.

Since:

5.0

Author:

Rossen Stoyanchev, Brian Clozel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractClientHttpRequest.State COMMITTING -> COMMITTED is the period after doCommit is called but before the response status and headers have been applied to the underlying response during which time pre-commit actions can still make changes to the response status and headers.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.util.function.Supplier<? extends <any>>>	commitActions
private MultiValueMap<java.lang.String,HttpCookie>	cookies
private HttpHeaders	headers
private java.util.concurrent.atomic.AtomicReference<AbstractClientHttpRequest.State>	state

Constructor Summary

Constructors

Constructor and Description
AbstractClientHttpRequest()
AbstractClientHttpRequest(HttpHeaders headers)

Method Summary

Modifier and Type	Method and Description
protected abstract void	applyCookies() Add cookies from getHeaders() to the underlying response.
protected abstract void	applyHeaders() Apply header changes from getHeaders() to the underlying response.
void	beforeCommit(java.util.function.Supplier<? extends <any>> action) Register an action to apply just before the HttpOutputMessage is committed.
protected <any>	doCommit() A variant of doCommit(Supplier) for a request without body.
protected <any>	doCommit(java.util.function.Supplier<? extends <any>> writeAction) Apply beforeCommit actions, apply the request headers/cookies, and write the request body.
MultiValueMap<java.lang.String,HttpCookie>	getCookies() Return a mutable map of request cookies to send to the server.
HttpHeaders	getHeaders() Return the headers of this message.
boolean	isCommitted() Whether the HttpOutputMessage is committed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.http.client.reactive.ClientHttpRequest

getMethod, getURI

Methods inherited from interface org.springframework.http.ReactiveHttpOutputMessage

bufferFactory, setComplete, writeAndFlushWith, writeWith

Field Detail

headers

private final HttpHeaders headers

cookies

private final MultiValueMap<java.lang.String,HttpCookie> cookies

state

private final java.util.concurrent.atomic.AtomicReference<AbstractClientHttpRequest.State> state

commitActions

private final java.util.List<java.util.function.Supplier<? extends <any>>> commitActions

Constructor Detail

AbstractClientHttpRequest

public AbstractClientHttpRequest()

AbstractClientHttpRequest

public AbstractClientHttpRequest(HttpHeaders headers)

Method Detail

getHeaders

public HttpHeaders getHeaders()

Description copied from interface: HttpMessage

Return the headers of this message.

Specified by:

getHeaders in interface HttpMessage

Returns:

a corresponding HttpHeaders object (never null)

getCookies

public MultiValueMap<java.lang.String,HttpCookie> getCookies()

Description copied from interface: ClientHttpRequest

Return a mutable map of request cookies to send to the server.

Specified by:

getCookies in interface ClientHttpRequest

beforeCommit

public void beforeCommit(java.util.function.Supplier<? extends <any>> action)

Description copied from interface: ReactiveHttpOutputMessage

Register an action to apply just before the HttpOutputMessage is committed.

Specified by:

beforeCommit in interface ReactiveHttpOutputMessage

Parameters:

action - the action to apply

isCommitted

public boolean isCommitted()

Description copied from interface: ReactiveHttpOutputMessage

Whether the HttpOutputMessage is committed.

Specified by:

isCommitted in interface ReactiveHttpOutputMessage

doCommit

protected <any> doCommit()

A variant of doCommit(Supplier) for a request without body.

Returns:

a completion publisher

doCommit

protected <any> doCommit(@Nullable
                         java.util.function.Supplier<? extends <any>> writeAction)

Apply beforeCommit actions, apply the request headers/cookies, and write the request body.

Parameters:

writeAction - the action to write the request body (may be null)

Returns:

a completion publisher

applyHeaders

protected abstract void applyHeaders()

Apply header changes from getHeaders() to the underlying response. This method is called once only.

applyCookies

protected abstract void applyCookies()

Add cookies from getHeaders() to the underlying response. This method is called once only.